home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / fdla100.arc / FDLA.DOC next >
Text File  |  1991-12-17  |  20KB  |  425 lines
  1.  
  2.  
  3.                   FrontDoor Log Analyzer - FDLA Version 1.00
  4.             Copyright 1991 by R.J. (Bob) Ross - ALL RIGHTS RESERVED
  5.                  SysOp - RJ's Byteline BBS - FidoNet 1:134/75
  6.  
  7.                               14 December, 1991
  8.  
  9.  
  10.     Short Preamble
  11.     --------------
  12.  
  13.     FDLA is a filter program to extract information contained in the
  14.     FrontDoor logfile generated by the FrontDoor program.  It provides a
  15.     summary of the incoming/outgoing calls, mail/file transfers, session
  16.     costs undialable nodes and BBS caller activity over the period covered
  17.     by the FrontDoor log file.
  18.  
  19.     I claim no credit for any portion of FrontDoor or QSort programs.  All
  20.     Advanced Engineering sarl and Joaquim H. Homrighausen products are
  21.     trademarks or registered trademarks of Advanced Engineering sarl or
  22.     Joaquim H. Homrighausen.  QSort Text Sort program is copyright by Ben
  23.     Baker.
  24.  
  25.     FDLA is free for use in a non commercial environment and may be copied
  26.     and distributed freely and publicly for this purpose.  I do request
  27.     that you register your copy of FDLA though.  This is primarily to feed
  28.     my ego and satisfy my curiosity on where my programs are being used. I
  29.     have a world map on my wall and stick map pins in at the geographical
  30.     location of known users of my programs.  Please see Register.txt
  31.     included with this documentation.  If you use FDLA I ask that you take
  32.     a few moments to complete it and send it off to me.
  33.  
  34.     Commercial establishments who wish to use FDLA, please contact me.  We
  35.     can work something out.
  36.  
  37.     FDLA is distributed "as is" and is guaranteed to do nothing except take
  38.     up space on your disk.  I do hope that you will find it more useful
  39.     though.  It does run on my IBM clone machine and the IBM compatible
  40.     machines that it has been beta tested on.
  41.  
  42.     Kick Start
  43.     ----------
  44.  
  45.     For a "kick start" just place FDLA.EXE in any convenient directory on
  46.     your hard disk but preferably in the same directory that FrontDoor
  47.     creates it's log file in.  At the DOS prompt, type FDLA -H to display
  48.     the help screen.
  49.  
  50.     Command Line Switches
  51.     ---------------------
  52.  
  53.     FDLA [<-switch>] [LOG=logfilename]
  54.  
  55.     All switches are optional as is the log filename and may be given in
  56.     any order. Parsing of switches -H, -LL and -SN, are in -SN, -H and -LL
  57.     order and are exclusive for obvious reasons.  If no command line
  58.     arguments are given, FDLA defaults to creating FDLARpt.Txt and uses the
  59.     FrontDoor log (FD.LOG) in the default directory.
  60.  
  61.  
  62.  
  63.  
  64.  
  65.                                      - 2 -
  66.  
  67.         Switches
  68.         -------
  69.                  No switch on the command line will produce FDLARpt.Txt
  70.                  providing that FDLA resides in the same directory as the
  71.                  FrontDoor log file and a log file exists in the name of
  72.                  FD.LOG.
  73.  
  74.         -D       Will make a data file FDLARpt.Dat containing the data,
  75.                  plus some additional data, displayed in Part I of the
  76.                  output report (FDLARpt.Txt) file.  FDLARpt.Dat is a comma
  77.                  delimited text file which may be useful for other
  78.                  applications.  A record field description of FDLARpt.Dat
  79.                  file is outlined in Annex B to this document file.
  80.  
  81.         -EXN     -EXNNet:Node (ie -EXN1:134) will exclude a Net from Part I
  82.                  of report (FDLARpt.Txt) file.  Note: No space after -EXN.
  83.                  Actually, you could exclude just one Node if desired. (ie
  84.                  -EXN1:134/75)
  85.  
  86.         -H       A brief help screen which describes the switches used to
  87.                  determine the program options or behaviour.
  88.  
  89.         -KTF     Will cause the temporary work files created by FDLA to be
  90.                  retained.  Temporary files created are:
  91.  
  92.                        FDLATmp.$$$  - created to hold data extracted from
  93.                                       the log file file to produce Part I
  94.                                       of the FDLA output report file to
  95.                                       summarize mail transfers and
  96.                                       incoming/outgoing calls.
  97.  
  98.                        FDLATmp.$$S  - Sorted output from FDLATmp.$$$ input.
  99.  
  100.                        FDLATmpF.$$$ - created to hold data extracted from
  101.                                       the log file to produce Part II of
  102.                                       the FDLA output report file to
  103.                                       itemize file transfers.
  104.  
  105.                        FDLATmpF.$$S - Sorted output from FDLATmpF.$$$
  106.                                       input.
  107.  
  108.                        FDLATmpC.$$$ - A picture image of Session Cost Part
  109.                                       III portions of the output report
  110.                                       minus the closing last line.
  111.  
  112.                        FDLATmpU.$$$ - created to hold data extracted from
  113.                                       the log file to produce Part IV -
  114.                                       Undialable Nodes.
  115.  
  116.                        FDLATmpU.$$S - Sorted output from FDLATmpU.$$$
  117.  
  118.         -L       List FDLARpt.Txt to the screen after it has been produced
  119.                  by FDLA.  The list procedure supports PgUp, PgDn, left,
  120.                  right, up down arrow keys, Esc and X to exit.
  121.  
  122.         -LL      Will list that last created FDLARpt.Txt residing in FDLA's
  123.                  home directory if it exists.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                      - 3 -
  130.  
  131.         -NHA     By default, FDLA will use high Ascii characters to draw
  132.                  the boxes for the FDLARpt.Txt file output report.  Using
  133.                  the -NHA switch will make FDLA use only low Ascii
  134.                  characters (-+) to draw borders and boxes for the report.
  135.  
  136.         -SN      System Name.  Allows you to modify the FDLA.EXE program to
  137.                  include your System Name.  If this switch is selected you
  138.                  will be prompted to enter your System Name.  Upon
  139.                  completion, FDLA will modify itself and exit to DOS.
  140.                  Subsequent runs that generate FDLARpt.Txt will then print
  141.                  your System Name at the top of the output report.
  142.  
  143.                  NOTE: This option will not work if you compress FDLA.EXE
  144.                  using an execute file compressor (LZEXE, PKLITE, etc)
  145.                  prior to modifying the FDLA execute file to include your
  146.                  system name.  If you do, I can almost guarantee that you
  147.                  will lock up your system if you try to run FDLA after
  148.                  compression.  You should be able to use the -SN option to
  149.                  add your System Name and then compress the execute file
  150.                  though.
  151.  
  152.         LOG=     LOG=drive:\path\log filename.  Allows FDLA to run using
  153.                  log file names other than FD.LOG in the default directory
  154.                  or to run on a drive or in a directory other than where
  155.                  the log file is maintained by FrontDoor.
  156.  
  157.  
  158.     Pitfalls
  159.     --------
  160.  
  161.     Some resident virus detectors may complain about FDLA.EXE being
  162.     modified when you use the -SN switch.  Also see NOTE under -SN
  163.     regarding compressing FDLA.EXE.
  164.  
  165.     As mentioned earlier, FDLA creates some temporary work files. If you
  166.     run out of disk space while FDLA is executing, this is probably the
  167.     reason why.  The solution; more disk space or smaller log files. Unless
  168.     you use the -KTF switch, the work files will be deleted from your disk
  169.     when FDLA has completed it's final output report.  The used disk space
  170.     consumed by the temporary files will then be returned to your system.
  171.  
  172.     FDLA needs to go out to DOS to externally sort some of it's work files
  173.     (FDLATmp?.$$$).  The default sort program used is QSort by Ben Baker. If
  174.     DOS fails to find QSORT an error is returned to FDLA and it then looks
  175.     for the DOS SORT program on your path and re-starts the sort process.
  176.  
  177.     I highly recommend the use QSORT because it's much faster than SORT,
  178.     uses less memory and will sort a file of any size subject to disk space
  179.     limitations.  If the sort is unsuccessful then the FDLA will terminate
  180.     with a DOS error level of 1. If the program ends with an Out of Data
  181.     error and indicates that file FDLATmp.$$S is nul, chances are you
  182.     either ran out of memory or disk space.  If you use the regular DOS
  183.     SORT utility on LARGE log files, your chances of FDLA failing are VERY
  184.     GOOD.  The best solution is to use QSort.
  185.  
  186.     If you run FDLA from a batch file the program will exit with an error
  187.     level of 0 on successful completion.  An error level of 1 will be
  188.     returned to DOS if FDLA fails for any reason.
  189.  
  190.  
  191.  
  192.                                      - 4 -
  193.  
  194.     Conclusion
  195.     ----------
  196.  
  197.     I will endeavour respond to and correct any reported bugs.  I do not
  198.     personally use FrontDoor as a mailer for my BBS however FDLA has been
  199.     beta tested at a few high traffic nodes in FidoNet 1:134 and appears to
  200.     be quite stable.  I can only respond if log file samples are sent to me
  201.     at FidoNet 1:134/75 so that I may analyze any reported problems and
  202.     make appropriate corrective action.
  203.  
  204.     Please realize that although, to a non commercial user, FDLA is
  205.     freeware, it costs real out of pocket money to develop and distribute
  206.     FDLA both by myself and the SysOps who are gracious enough to
  207.     distribute FDLA over the FidoNet Software Distribution Network (SDN)
  208.     and other networks.
  209.  
  210.     The output of FDLA is not cast in stone.  I'm always open to
  211.     suggestions to improve the report or this documentation. Some users may
  212.     notice that FDLA looks a lot like BinkLA, the BinkleyTerm Log Analyzer.
  213.     That's because I wrote BinkLA. I incorporated many of BinkLA's features
  214.     in FDLA.
  215.  
  216.     The source code for FDLA will not be released either to the public
  217.     domain or with copyright retention.  FDLA does contain some library
  218.     calls from a commercial library which are proprietary.
  219.  
  220.     The latest version of FDLA (Beta or otherwise) will always be available
  221.     at RJ's Byteline BBS, FidoNet 1:134/75, using magic file name FDLA or
  222.     may be downloaded from File Area 1 without prior registration.  My
  223.     system presently uses a Courier HST DS V32b V42b modem for high speed
  224.     V32 and HST connections.
  225.  
  226.     A sample output of FDLA FDLARpt.Txt file is included as Annex A to this
  227.     document file.  Field and record descriptions for the files created by
  228.     FDLA are included as Annex B.
  229.  
  230.     Enjoy.....
  231.  
  232.                                  Yours truly,
  233.  
  234.  
  235.                                 R.J. (Bob) Ross
  236.  
  237.  
  238.  
  239.  
  240.                                                            Annex A
  241.  
  242.     Sample output of FDLARpt.Txt.  Please note portions of Part I and Part
  243.     II have been removed to shorten the sample.
  244.  
  245.  
  246. FD.LOG                                                     FDLA Version 1.00
  247.                                POSTMASTER
  248.                   FrontDoor Log Statistics for the period
  249.             From Tue 03 Sep 91  0:21:50  to  Thu 05 Sep 91  0:12:47
  250. ┌──────────────────┬────────────────────────────────────┬──────────────────┐
  251. │░░░░░░░░░░░░░░░░░░│ Part I - Message Transfers & Calls │░░░░░░░░░░░░░░░░░░│
  252. ╞══════════════╤═══╧════════════════╤═══════════════════╧═════╤══════╤═════╡
  253. │Zone:Net/Node │   Telephone Calls  │       Message Bytes     │  CPS │ Tran│
  254. │    Number    │ Out │ Connect │ In │ Outgoing   │  Incoming  │  Avg │  Min│
  255. ╞══════════════╧═════╧═════════╧════╧════════════╧════════════╧══════╧═════╡
  256. │1:134/0          27      21      6     103,948        69,161    739    3.9│
  257. │1:134/1           5      10      7      22,669       221,734   1357    3.0│
  258. │1:134/10         23      15      5      46,318        13,009    674    1.5│
  259. │1:134/11         13      13      0      31,300             0    601    0.9│
  260. │1:134/93         16      20      8      10,359         1,091    212    0.9│
  261. │1:358/1           0       2      2      55,364         1,383   1351    0.7│
  262. │1:381/61          1       1      0           0         1,342    671    0.0│
  263. ├──────────────────────────────────────────────────────────────────────────┤
  264. │ TOTALS        1219     865    157   4,635,721       474,697    341  249.8│
  265. ╘══════════════════════════════════════════════════════════════════════════╛
  266.  
  267. ┌───────────────────┬──────────────────────────────────┬───────────────────┐
  268. │░░░░░░░░░░░░░░░░░░░│ PART II - Network File Transfers │░░░░░░░░░░░░░░░░░░░│
  269. ╞══════════════╤════╧═══════════════╤══════════════════╧══════╤══════╤═════╡
  270. │Zone:Net/Node │                    │       File Bytes        │  CPS │ Tran│
  271. │    Number    │     File Names     │ Outgoing   │  Incoming  │ Rate │  Min│
  272. ╞══════════════╧════════════════════╧════════════╧════════════╧══════╧═════╡
  273. │1:134/0            FNEWS835.LZH              0        22,722   1623    0.2│
  274. │1:134/500          ECHO_INT.LST         19,586             0    233    1.4│
  275. │1:134/93           00860002.REQ              0            13      0    0.0│
  276. │1:134/93           00860002.REQ              0            13      0    0.0│
  277. ├──────────────────────────────────────────────────────────────────────────┤
  278. │ TOTALS                 7               33,929        22,775    354    2.7│
  279. ╘══════════════════════════════════════════════════════════════════════════╛
  280.  
  281. ┌───────────────────┬──────────────────────────────────┬───────────────────┐
  282. │░░░░░░░░░░░░░░░░░░░│ PART III - Network Session Costs │░░░░░░░░░░░░░░░░░░░│
  283. ╞══════════════╤════╧═══════════════╤══════════════════╧══════╤════════════╡
  284. │Zone:Net/Node │     Logged At      │       Session Time      │    Cost    │
  285. │    Number    │  Date   │   Time   │     Hrs │ Mins │ Secs   │            │
  286. ╞══════════════╧═════════╧══════════╧═════════╧══════╧════════╧════════════╡
  287. │1:381/61       04 Sep 91   6:31:50        0       0    21       $ 0.42    │
  288. ╘══════════════════════════════════════════════════════════════════════════╛
  289.  
  290. ┌───────────────────┬──────────────────────────────────┬───────────────────┐
  291. │░░░░░░░░░░░░░░░░░░░│    PART IV - Undialable Nodes    │░░░░░░░░░░░░░░░░░░░│
  292. ╞═══════════════════╧══════════════════════════════════╧═══════════════════╡
  293. │1:134/102           1:134/15            1:134/25                  1:134/45│
  294. │1:134/49            1:134/79            1:134/80                  1:134/81│
  295. ╘══════════════════════════════════════════════════════════════════════════╛
  296.  
  297. ┌──────────────────────────┬────────────────────┬──────────────────────────┐
  298. │░░░░░░░░░░░░░░░░░░░░░░░░░░│ PART  V - SUMMARY  │░░░░░░░░░░░░░░░░░░░░░░░░░░│
  299. ╞══════════════════════════╧════╤═══════════════╧══════════════════════════╡
  300. │ BBS Callers at  9600   =    1 │ Message Bytes Transferred    =  5,110,418│
  301. │                 2400   =   17 │ File Bytes Transferred       =     56,704│
  302. │                 1200   =    0 │ TOTAL Bytes Transferred      =  5,167,122│
  303. │                 Other  =    0 ├──────────────────────────────────────────┤
  304. │                               │ Message Connect Time         =        4.2│
  305. │ TOTAL BBS Callers      =   18 │ File Transfer Connect Time   =        0.0│
  306. │                               │ TOTAL Connect Time (Hours)   =        4.2│
  307. │ Rejected BBS Calls     =    5 │ TOTAL Network Session Costs  =   $   0.42│
  308. │                               ├──────────────────────────────────────────┤
  309. │                               │ Unsuccessful Connect Attempts=        511│
  310. └───────────────────────────────┴──────────────────────────────────────────┘
  311.  
  312.  
  313.                                                            Annex B
  314.  
  315.     Record description for file FDLARpt.Dat
  316.  
  317.        Field       Data Type                   Remarks
  318.     -----------------------------------------------------------------------
  319.     ZoneNetNode     STRING         A fixed length string of 15 characters
  320.                                    containing the Zone:Net/Node number.
  321.  
  322.     CallsOut        INTEGER        Positive numbers up to 32,767 which
  323.                                    contains a count of the number of
  324.                                    outgoing telephone calls.
  325.  
  326.     Connect         INTEGER        A count of the number of successful
  327.                                    telephone connects which includes both
  328.                                    outgoing and incoming connects.
  329.  
  330.     CallsIn         INTEGER        A count of the number of incoming
  331.                                    telephone calls.
  332.  
  333.     MByteOut        LONG           Positive numbers up to 2,147,483,647
  334.                                    which contains the total number of
  335.                                    message bytes transmitted to a
  336.                                    ZoneNetNode.
  337.  
  338.     MByteIn         LONG           Total number of message bytes received
  339.                                    from a ZoneNetNode.
  340.  
  341.     MTimeOut        INTEGER        Total transmission time (in seconds) to
  342.                                    transmit the total bytes in MByteOut.
  343.  
  344.     MTimeIn         INTEGER        Total transmission time (in seconds) to
  345.                                    receive the total bytes in MByteIn.
  346.  
  347.     MByteOutIn      LONG           MByteOut + MByteIn
  348.  
  349.     MTimeOutIn      LONG           MTimeOut + MTimeIn
  350.  
  351.     MAvgCPS         INTEGER        MByteOutIn \ MTimeOutIn
  352.  
  353.     MTimeMinute     SINGLE         precision floating point decimal.  Total
  354.                                    transfer time (MTimeOut + MTimeIn) / 60.
  355.  
  356.  
  357.  
  358.  
  359.                                      - 2 -
  360.  
  361.     Record description for temporary work files FDLATmp.$$$ & FDLATmp.$$S
  362.  
  363.        Field       Data Type                   Remarks
  364.     -----------------------------------------------------------------------
  365.  
  366.     ZoneNetNode     STRING         Fixed Length 15 characters contains
  367.                                    Zone:Net/Node number.
  368.  
  369.     MCallsOut       INTEGER        Number of telephone calls out.  Always 1
  370.                                    or 0.
  371.  
  372.     MConnect        INTEGER        Number of successful telephone connects.
  373.                                    Always 1 or 0.
  374.  
  375.     MCallsIn        INTEGER        Number of telephone calls in.  Always 1
  376.                                    or 0.
  377.  
  378.     MByteOut        LONG           Number of mail bytes transmitted during
  379.                                    a mail session.
  380.  
  381.     MByteIn         LONG           Number of mail bytes received during a
  382.                                    mail session.
  383.  
  384.     MTimeOut        INTEGER        Number of seconds to transmit MByteOut.
  385.  
  386.     MTimeIn         INTEGER        Number of seconds to receive MByteIn.
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                      - 3 -
  394.  
  395.     Record description for FDLATmpF.$$$ & FDLATmpF.$$S
  396.  
  397.        Field       Data Type                   Remarks
  398.     -----------------------------------------------------------------------
  399.     ZoneNetNode     STRING         Fixed length string of 15 characters
  400.                                    containing the Zone:Net/Node number.
  401.  
  402.     FileNm          STRING         Fixed length string of 12 characters
  403.                                    containing the outgoing/incoming DOS
  404.                                    filename.
  405.  
  406.     FileByteOut     LONG           Size in bytes of transmitted file.
  407.  
  408.     FileByteIn      LONG           Size in bytes of received file.
  409.  
  410.     FileCPS         INTEGER        Transmission CPS of outgoing/incoming
  411.                                    file.
  412.  
  413.  
  414.     Record description for FDLATmpU.$$$ & FDLATmpU.$$S
  415.  
  416.        Field       Data Type                   Remarks
  417.     -----------------------------------------------------------------------
  418.  
  419.     ZoneNetNode     STRING         Fixed length string of 15 characters
  420.                                    containing the Zone:Net/Node number.
  421.  
  422.  
  423.  
  424.  
  425.